Platform Explorer / Nuxeo Platform 2023.9

Component org.nuxeo.ecm.core.filter.CharacterFilteringService

In bundle org.nuxeo.ecm.core

Documentation

The character filtering service enables the filtering of unwanted characters. If filtering is enabled, by default the control characters not valid in XML specification will be removed from any field in document creation or update.

Resolution Order

101
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

805
The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.ecm.core.filter.CharacterFilteringServiceImpl

Services

Extension Points

XML Source

<?xml version="1.0"?>
<component name="org.nuxeo.ecm.core.filter.CharacterFilteringService">

  <service>
    <provide interface="org.nuxeo.ecm.core.filter.CharacterFilteringService" />
  </service>

  <implementation class="org.nuxeo.ecm.core.filter.CharacterFilteringServiceImpl" />

  <documentation>
    The character filtering service enables the filtering of unwanted characters.
    If filtering is enabled, by default the control characters not valid in XML specification
    will be removed from any field in document creation or update.
  </documentation>

  <extension-point name="filtering">
    <documentation>
      Extension point to set if filtering is enabled or disabled. Other characters can
      be added to be filtered if present.

      <code>
        <filtering enabled="true">
          <disallowedCharacters>
            <character>\r</character>
            <character>\t</character>
          </disallowedCharacters>
        </filtering>
      </code>

    </documentation>

    <object class="org.nuxeo.ecm.core.filter.CharacterFilteringServiceDescriptor" />

  </extension-point>
</component>